arrRegOff specifies the number of registers to increment in order to get consecutive values for a data group element used in an array. For example, if the regNum for array(0) = x, the regNum for array(1) = x + arrRegOff.

Value:

• Must be a positive whole number.
• Default is 1.

arrSize specifies the number of elements in a single array. Typically each element refers to a register. So an arrSize of 20 means 20 elements in a single array or 20 registers in a single array. You can also think of such registers as rows in a table or instances of data for a single data group element.

Value:

• Must use a positive whole number.

bitShift works with bMsk for legacy and extended (new) references, opSelect reference operation, and EFM mappings to indicate whether or not to shift off the masked low bits.

Value:

• false: Specifies that you do not want to shift bits.
• signed: Specifies that you want to preserve the sign bit during the shift.
• unsigned: Specifies that you want to shift the entire value.
• Default is unsigned.

See also opBitMask and Bit Mask Examples.

bMsk (bit mask) performs a bitwise AND operation on a referenced value when multiple bits are to be affected. bMsk cannot be used in the same element as bPos.

To make this attribute meter specific, append _ordn to the attribute. For example, bMsk_ord1.

Value:

• Requires a positive whole number. Can be hex. If using hex, the hex number must start with 0x (i.e., 0xF, 0x0F, 0x00F, or 0x000F).
• Must be greater than or equal to 1 (0x1 hex).
• Must fit in a 32-bit field.
• Default is unsigned bit shift, but may be overridden with bitShift to indicate whether to shift off the masked low bits.

See also Bit Mask Examples.

See also eFMS, eGMR.

bPos (bit position) requests the binary value of the bit in the bit position specified. bPos cannot be used in the same element as bMsk.

To make this attribute meter specific, append _ordn to the attribute. For example, bPos_ord1.

Value:

• Requires non-negative decimal or hex numbers only. If using hex, the hex number must start with 0x (i.e., 0xF, 0x0F, 0x00F, or 0x000F).
• Must be greater than or equal to 0 (0x0 hex) and less than or equal to 31 (0x1F).
• 0 - 7 are valid for an 8-bit field. 0 - 15 are valid for a 16-bit field. 0 - 31 are valid for a 32-bit field.
• Always does an unsigned bit shift.

See also Bit Position Examples.

bXorMask (bit XOR mask) performs a bitwise XOR operation on a referenced value when one or more bits are to be affected. bXorMask is used in reference methods.

Value:

• Requires integer and hex only. If using hex, the hex number must start with 0x (i.e., 0xF, 0x0F, 0x00F, or 0x000F).
• Must be greater than or equal to 0 (0x0 hex).
• Must fit in a 32-bit field.

byteOrder specifies how data group element byte positions for multi-byte data are represented on a field device. Refer to the field device protocol or user manual to find out what format is followed by your field device.

Value:

• bigEndian: Most significant byte is sent first.
• intel: Least significant byte is sent first.
• littleEndian: Least significant byte is sent first.
• motorola: Most significant byte is sent first.
• Default is littleEndian.

Value:

• Any valid mask can be used. It is typically used to record a value of a certain decimal point precision. For example, %0.2f means that the applicable floating point number only shows two decimal places. See printf documentation for value formats and options.

cvtF specifies that a conversion method is to be used to convert source data of one format into a different target format. cvtF conversions can vary by EIE type.

Value:

• Numerous CygNet-defined conversions are available. Each uses a specific keyword value.

See also cvtF Conversion Methods.

cvtRef specifies that a special reference conversion method is to be used to convert source data of one format into a different target format for display or use by another element.

Value:

• Numerous CygNet-defined conversions are available. Each uses a specific keyword value.

See also cvtRef Conversion Method.

deidDate references a data group element that provides a source date value. deidDate is used in various time conversions.

Value:

• Valid and applicable DEID.
• Source format varies depending on the method with which it is used.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidDay references a data group element that provides a source day value. deidDay is used in various time conversions.

Value:

• Must be a number 1-31.

See cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidDayOfWeek references a data group element that provides a source day of the week value. deidDayOfWeek is used in various time conversions.

Value:

• Must be a number 1-7, where 1 = Sunday, 2 = Monday, and so forth.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidHour references a data group element that provides a source hour value. deidHour is used in various time conversions.

Value:

• Must be a number 0-23.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidMinute references a data group element that provides a source minute value. deidMinute is used in various time conversions.

Value:

• Must be a number 0-59.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidMonth references a data group element that provides a source month value. deidMonth is used in various time conversions.

Value:

• Must be a number 1-12.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidSecond references a data group element that provides a source month value. deidSecond is used in various time conversions.

Value:

• Must be a number 0-59.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidTime references a data group element that provides a source time value. deidTime is used in various time conversions.

Value:

• Valid and applicable DEID.
• Source format varies depending on the method with which it is used.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

deidYear references a data group element that provides a source year value. deidYear is used in various time conversions.

Value:

• Must be a four-digit number.

See also cvtRef Conversion Method and Reference Methods – Time Formatting Examples.

desc is the user-defined description of a data group element, typically used as a name or title. Depending on implementation, sometimes this attribute's value appears in remote device editors and sometimes it does not.

Value

• User-defined string, no character limit.

This attribute is not required by a data group element. But if it is used, it cannot be blank.

devRevDeid stores the value of the specified DEID to the Revision field in the DDS.

Value:

• Data group element that represents the device version.

divZeroAction is used in combination with the opDiv and opDivId reference operations. It specifies what happens if a division operation attempts to divide by zero.

Value:

• returnFalse: Returns N/A and no computation takes place.
• returnSentinel: Requires you to also use the attribute divZeroSentinel, which specifies a constant.
• Value can be blank. A blank value returns zero ("0") and no computation takes place.

See also Reference Operations and Reference Methods – Arithmetic Examples.

divZeroSentinel is used in combination with the opDiv and opDivId reference operations. It is only applicable if returnSentinel is used as the value for divZeroAction. It specifies what happens if a division operation attempts to divide by zero.

Value:

• User-defined numeric constant.

See also Reference Operations and Reference Methods – Arithmetic Examples.

dMask is a display mask that specifies how a value is to be displayed in remote device editors. dMask is based on the printf function used in the C language.

Value:

• Any valid mask can be used. It is typically used to display a value in hex. For example, 0x%08X (8 hex characters), 0x%04X (4 hex characters), and 0x%02X (2 hex characters). See printf documentation for value formats and options.

elemAddr defines an element address as it has been defined on an Allen-Bradley SLC field device.

In a data group element, the elemAddr attribute enables you to specify the components needed to access virtually any data item on an associated SLC-503/4/5 controller. The syntax of the elemAddr attribute value follows the SLC standard, including the various Allen-Bradley SLC-503/4/5 delimiters.

Value:

• An Allen-Bradley standard element address that follows Allen-Bradley conventions for values and syntax.

See also Creating SLC-503/4/5 Custom Data Groups.

externalId provides a hook for an external user.

Value:

• Any applicable string.

fldAccess defines whether an element is read-only or read/write in Emerson ROC or Emerson ROCPlus device template files.

Value:

• RO: read-only
• RW: read/write

format converts source data group element data into a human-readable format in a reference method conversion in a destination data group element.

Value:

• Any CygNet-defined and applicable formatting keyword may be used. See below.
• CygDateTime: Days since midnight 12/30/1899
• Date: dd-MMM-yy
• DateTime: dd-MMM-yy hh:mm:ss
• Duration: d hh:mm:ss
• FeetInchesFromInches: Converts a number of inches into feet (') and inches (").
• General Date: MM/dd/yyyy hh:mm:ss AM/PM
• Long Date: Day of Week, Month dd, yyyy
• Long Time: hh:mm:ss AM/PM
• Medium Date: dd-MMM-yy
• Medium Time: hh:mm AM/PM
• MMM dd yyyy hh:mm:ss: MMM dd yyyy hh:mm:ss
• Short Date: MM/dd/yyyy
• Short Time: hh:mm
• Time: hh:mm:ss

See also Reference Methods.

fromSupportDg specifies that a data group element derives its data from one or more support data groups. It is used when a data group element has one or more source child elements, typically within a composite data group.

Value:

• Must be a Boolean value true or false.

hidden specifies that a data group element does or does not appear in a remote device data group editor.

Value:

• Must be a Boolean value true or false.

index specifies the position in an array in OPC EIE device template files.

Value

• Must be a positive whole number.

isArray specifies that a data group element is an array item in OPC EIE device template files.

Value:

• Must be a Boolean value true or false.

isRef specifies that a data group element is an advanced reference method.

Value:

• Must be a Boolean value true or false.

See also Reference Methods.

item is the numeric identifier that represents the II in the PPSSII Pointer (Process.Section.Item) scheme used by Eagle field devices.

Value

• Must be a positive whole number.
• Must be a valid item number as defined by the field device manufacturer.

itemId is the item identifier as defined on the OPC server. To make this attribute data group specific, append _ordn to the attribute. For example, itemID_ord1="".

len specifies the number of bytes in a data group element or register.

Value:

• Must be a positive whole number.

lowByte specifies whether or not character data in a two-byte string is in the low byte or high byte.

Value:

• Must be a Boolean value true or false.

mapVal maps an enumeration table keyword to an enumeration table of the same name.

The referenced table can be scoped to a data group element, scoped to a device template file (using an enums table), or be one of several global tables. First the data group element in which the mapVal attribute is defined is searched for a table local to it. If no such table is found, a wider search occurs in which the device template file and the global tables are searched for a corresponding enumeration table of the same name.

mapVal can be used in both a basic reference method and an advanced reference method in similar ways. In a basic reference method, mapVal must be defined in-line along with a ref attribute. In an advanced reference method, if mapVal is used, it must be defined in-line along with a refOp attribute set to opMapVal.

If the mapVal attribute references an enumeration table in a device template file, a drop-down menu containing the defined enum values will display when editing the specified data group element value on the data group's View Data dialog box. The enumeration values must be unique for the values to display in a drop-down menu.

(In an eFMS or eGMR element, mapVal is used in combination with the deid attribute, which maps the eFMS or eGMR element to a value.)

Value:

• Must match the name of the applicable enumeration table.
• Must be unique within the applicable scope so that no name conflicts occur.

See also enums and Enumeration Mapping Examples.

nullPad enables you to specify that a fixed-length string value is to be terminated with the applicable number of null characters.

Value:

• Must be a Boolean value true or false.
• Cannot be used in the same element as spacePad.

off indicates the byte offset of the value in the event record from the field device.

Value

• Must be an integer.

paramID defines a device-specific parameter ID. To make this attribute data group specific, append _ordn to the attribute. For example, paramID_ord1="1234".

Currently implemented for use with eProd devices, where it specifies a data location value.

Value:

• Typically a positive whole number.

processType is the process type numeric identifier assigned by Eagle field devices.

Value

• Must be a positive whole number.
• Must be a valid process type number as defined by the field device manufacturer.

rangeHigh specifies that an input value must be less than or equal to the value assigned to this attribute.

This attribute affects user input in a generic grid dialog box. If a user attempts to enter a value for a given data group element and that value is out of range, an error message appears.

Value:

• Any value that conforms to the data type defined in the same data group element as this attribute. For example, if type="ui2" and rangeHigh="70000", the data group element is invalid.

rangeLow specifies that an input value must be greater than or equal to the value assigned to this attribute.

This attribute affects user input in a generic grid dialog box. If a user attempts to enter a value for a given data group element and that value is out of range, an error message appears.

Value:

• Any value that conforms to the data type defined in the same data group element as this attribute. For example, if type="ui2" and rangeLow="70000", the data group element is invalid.

recordItems is used by OPC devices when constructing an array of records from a single OPC array item. It indicates the number of items in an OPC array that constitute a record.

Value:

• Must be a positive whole number.

ref references another data group element. The referenced data group element supplies data for the referencing data group element. It is required in basic reference methods. If ref is used in a basic reference method, it must be paired with a reference operation in order to be considered valid. Do not confuse the ref element with the ref attribute.

Value:

• Valid and applicable data group element ID (DEID).

See also Reference Methods.

regDef defines both the read/write block and the register offset for an element in an ordinalized data group.

regDef cannot be used in the same element as regNum or structOff.

Value:

• Positive whole numbers only, separated by a colon (:). For example, 3:4.
• Must use the format x:y, where x is the block and y is the register offset from the group’s starting register number. For example, 3:4.

regNum defines a register number.

regNum cannot be used in the same element as regDef or structOff.

For information about the Totalflow EIE use of this attribute, see Totalflow EIE – Register Data Group.

Value:

• Usually a positive whole number, but there is variation among EIEs.
• Usually must be a value that is included in the data group's block element(s).

scaleFactor defines a constant multiplier. Multiplication is powered by some other mechanism, like the reference operation opScaleFactor or the cvtF conversion method Scale.

scaleFactor cannot be used in the same element as scaleFactorId. It also cannot be used in the same element as any two-point scaling attribute, like scaleLoRaw.

Value:

• Must be an integer or floating point number.

scaleFactorId multiplies a value by a referenced value. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleFactorId is used in linear scaling in reference methods.

scaleFactorId cannot be used in the same element as scaleFactor. It also cannot be used in the same element as any two-point scaling attribute, like scaleLoRaw.

Value:

• Requires a valid referenced data group element ID (DEID) that is in the same data group.
• The referenced DEID cannot be recursive (i.e., self-referential).

scaleHiEng defines a high engineering value in a two-point engineering scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleHiEng is used in linear scaling in reference methods.

scaleHiEng cannot be used in the same element as scaleHiEngId. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a numeral (positive, negative, or float) only.

scaleHiEngId defines a high engineering value in a two-point engineering scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleHiEngId is used in linear scaling in reference methods.

scaleHiEngId cannot be used in the same element as scaleHiEng. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a valid referenced data group element ID (DEID) that is in the same data group.
• The referenced DEID cannot be recursive (i.e., self-referential).

scaleHiRaw defines a high raw value in a two-point raw scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleHiRaw is used in linear scaling in reference methods.

scaleHiRaw cannot be used in the same element as scaleHiRawId. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a numeral (positive, negative, or float) only.

scaleHiRawId defines a high raw value in a two-point raw scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleHiRawId is used in linear scaling in reference methods.

scaleHiRawId cannot be used in the same element as scaleHiRaw. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a valid referenced data group element ID (DEID) that is in the same data group.
• The referenced DEID cannot be recursive (i.e., self-referential).

scaleLoEng defines a low engineering value in a two-point engineering scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleLoEng is used in linear scaling in reference methods.

scaleLoEng cannot be used in the same element as scaleLoEngId. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a numeral (positive, negative, or float) only.

scaleLoEngId defines a low engineering value in a two-point engineering scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleLoEngId is used in linear scaling in reference methods.

scaleLoEngId cannot be used in the same element as scaleLoEng. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a valid referenced data group element ID (DEID) that is in the same data group.
• The referenced DEID cannot be recursive (i.e., self-referential).

scaleLoRaw defines a low raw value in a two-point raw scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleLoRaw is used in linear scaling in reference methods.

scaleLoRaw cannot be used in the same element as scaleLoRawId. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a numeral (positive, negative, or float) only.

scaleLoRawId defines a low raw value in a two-point raw scale. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleLoRawId is used in linear scaling in reference methods.

scaleLoRawId cannot be used in the same element as scaleLoRaw. It also cannot be used in the same element as any non-two-point scaling attribute, like scaleFactor or scaleOffset.

Value:

• Requires a valid referenced data group element ID (DEID) that is in the same data group.
• The referenced DEID cannot be recursive (i.e., self-referential).

scaleOffset adds an input value to a constant value. The original, non-scaled input value must be preserved in a different data group element, typically in the same data group.

scaleOffset cannot be used in the same element as scaleOffsetId. It also cannot be used in the same element as any two-point scaling attribute, like scaleLoRaw.

Value:

• Requires a numeral (positive, negative, or float) only.

scaleOffsetId adds an input value to a referenced value. The original, non-scaled input value must be preserved in a different data group element in the same data group. scaleOffsetId is used in linear scaling in reference methods.

scaleOffsetId cannot be used in the same element as scaleOffset. It also cannot be used in the same element as any two-point scaling attribute, like scaleLoRaw.

Value:

• Requires a valid referenced data group element ID (DEID) that is in the same data group.
• The referenced DEID cannot be recursive (i.e., self-referential).

secLev defines the security level applicable to a data group's elements. This security can be applied to the data group elements as a group or to individual elements of the group.

Value:

• Integer value 0-5, where the values correspond to security levels in the DDS.
• Default is 4.

See also Custom Data Group Security.

secondsSince is only applicable in a TimeTLocalOffset conversion method. It specifies the offset from January 1, 1970 from which to append a value returned from deidTime.

Value:

• User-defined string.
• Must be in format YYYYMMDDHHMMSSNNN, where NNN are optional milliseconds.
• Must post-date January 1, 1970.

section is the numeric identifier that represents the SS in the PPSSII Pointer (Process.Section.Item) scheme used by Eagle field devices.

Value

• Must be a positive whole number.
• Must be a valid section number as defined by the field device manufacturer.

sourceDg specifies the source data group from which a data group element or source element derives its data. The referenced source data group must be defined in a supportDg element in the same composite data group in which sourceDg is used.

Value:

• Valid child data group element from within a supportDg element.

sourceDeid specifies the source data group element from which a data group element or source element derives its data. When used in a composite data group, sourceDeid is used in combination with the sourceDg attribute. The referenced source data group element must be part of a support data group as referenced in a supportDg element in the same composite data group in which sourceDeid is used.

Value:

• For a composite data group, sourceDeid must exist within a supportDg element.
• For an OPC EIE array-type data group, sourceDeid must exist in the same data group

sourceType defines the source data type of a value; it can be inherited from a parent element. It can be used in cases where a source data type is converted to a destination data type. When using this attribute in a type conversion, test that the source data type and the destination data type are complementary and that value precision is not negatively affected.

Value:

• boolean: Boolean
• i1: Character
• i2: Short integer
• i4: Integer
• i8: Integer
  
• r4: Float
• r8: Double
• ui1: Byte
• ui2: Unsigned short integer
• ui4: Unsigned integer
• ui8: Unsigned integer
• string: String
• struct: Structure

See also type.

spacePad enables you to specify that a fixed-length string value is to be terminated with the applicable number of space characters.

Value:

• Must be a Boolean value true or false.
• Cannot be used in the element with nullPad.

strFormat is only applicable in a TimeString conversion method. It specifies the format of the string representation to be sent. For example, strFormat="%m/%d/%y %H:%M:%S" would send a value to be interpreted like 01/30/07 10:22:00. It is only required if the time can be sent to the device.

Value:

• Applicable time tokens.

structOff defines the block and byte offset combination used to define data group elements that are derived from a structure.

As implemented for AutoCom beam devices, this attribute only makes sense when an applicable block has been defined that includes the following attributes: len, regCnt, regNum, and type.

structOff cannot be used in the same element as regNum or regDef.

Value:

• Positive whole numbers only, separated by a colon (:). For example, 3:4.
• Must use the format x:y, where x is the structure block and y is the byte offset from the structure’s starting register number. For example, 3:4.

tagname defines a user-defined tag name as it has been defined in an Allen-Bradley controller.

Tag names are the primary mapping element between CygNet SCADA data groups and Logix5000 data items. A tag is merely the name portion of a name-value pair that represents the output of an Allen-Bradley function. A CygNet SCADA device template file uses the XML element tagname to correlate a CygNet SCADA data point with an Allen-Bradley controller tag.

Value:

• User-defined string that maps to applicable Allen-Bradley controller tag name.

See also Creating Logix5000 Custom Data Groups.

type defines the appropriate data type for one or more DataGroupElement elements; it can be inherited from a parent element.

Value:

• bin.hex: Binary hex
• boolean: Boolean
• i1: Character
• i2: Short integer
• i4: Integer
• i8: Integer
  
• r4: Float
• r8: Double
• ui1: Byte
• ui2: Unsigned short integer
• ui4: Unsigned integer
• ui8: Unsigned integer
• string: String
• struct: Structure

See also sourceType.

udc specifies the uniform data code (UDC) used to map to a data group element.

Value:

• Any valid UDC can be used.

See also Uniform Data Codes.

units defines the unit type by which a value is identified in the DDS. The unit type assigned to a value in the DDS affects how the value is treated if the value is processed as a CygNet point in the PNT. For example, a value in the DDS using units="feet" is converted to meters in the PNT if the primary unit for the corresponding point is m (meter).

If a units attribute is used in a basic reference method, it might perform a conversion on the source value. Make sure that the source value and the destination value are the same or complementary.

If a units attribute is used in an advanced reference method, it might override desired units. Use the opUnitConversion reference operator and its supporting attributes srcUnits and destUnits.

Value:

• Any valid unit type. See PNT Engineering Units.
• If used to convert a unit type from a source data group element to a different destination unit type, the unit types must be complementary. For example, seconds to minutes or hours.

unitsCat identifies the name of a category of units associated with the data group element. It is used for devices that have configurable units.

For example, unitsCat="energy" means that the units for this data group element are defined by the energy category.

Value:

• A string that matches a unit category defined in the unitSetDefinitions section of the template file.

unitsCatValue indicates that the value of this data group element selects which units to use for the category identified by this attribute. It is used only with the data group that has dgCat="cfgUnitSets" for devices that have configurable units.

For example, unitsCatValue="staticPresIn" means that the value of this data group element selects which units to use for all static pressure inputs.

Value:

• A string that matches a unit category defined in the unitSetDefinitions section of the template file.

unitSet specifies whether or not a field device can categorize units by set. It is used in a dgCat="cfgUnitSets" data group.

Value:

• Must be a Boolean value true or false.

See also unitSetDefinitions.

unitSetName identifies the name of the unit set associated with the data group element. It is in conjunction with unitsCat and unitsCatValue for devices that have multiple, named configurable unit sets.

For example, unitSetName="input" unitCat="energy" means that the units for this data group element are defined by the energy category within the "input" unit set.

Value

• A string that names a unit set.

unitSetNameValue indicates that the value of this data group element selects which unit set to use for this named set. It is used only with the data group that has dgCat="cfgUnitSets" for devices that have multiple, named configurable unit sets.

For example, unitSetName="input" means that the value of this data group element selects which unit set from the unitSetDefinitions section of the template file to use for the "input" unit set.

Value

• A string that names a unit set.

wordSwap reverses the order of the two-byte words in a four-byte item without reversing the bytes in each word.